GET Users?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves users for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
take |
Number of users to retrieve. Default is all users |
integer |
None. |
skip |
Number of users to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the users before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of users.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "UserId": "ec294fce-ab4b-4ff7-ab01-988093f3d617", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "0460e1f0-4c0a-4a36-8cd5-3cd65c1c5263", "Teams": [ { "TeamId": "44d0624a-6338-4e3c-aaad-38d8ff6e0459", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4b08b43b-ef2e-4f79-a6c9-fa2caf624095", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "44d0624a-6338-4e3c-aaad-38d8ff6e0459", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4b08b43b-ef2e-4f79-a6c9-fa2caf624095", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ] }, { "UserId": "ec294fce-ab4b-4ff7-ab01-988093f3d617", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "0460e1f0-4c0a-4a36-8cd5-3cd65c1c5263", "Teams": [ { "TeamId": "44d0624a-6338-4e3c-aaad-38d8ff6e0459", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4b08b43b-ef2e-4f79-a6c9-fa2caf624095", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "44d0624a-6338-4e3c-aaad-38d8ff6e0459", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5009cfe7-5922-40d7-9553-be0266b0053e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "MeasurementValueNeededDate": "2024-05-05T21:12:21.3750011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee34a94d-411c-448d-90e0-9c950d9797f0", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4b08b43b-ef2e-4f79-a6c9-fa2caf624095", "CreateDate": "2024-05-05T21:12:21.3750011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-05T21:12:21.3750011-07:00", "LastModifiedUser": "sample string 6" } ] } ], "Total": 1, "Message": "sample string 1" }